home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / flev110.zip / FLEVEL.DOC < prev    next >
Text File  |  1991-03-04  |  14KB  |  364 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.       
  8.       
  9.       
  10.       
  11.                           U
  12.                         F   N
  13.                              -           !
  14.                                L       L
  15.                                  E   E 
  16.                                    V
  17.       
  18.       
  19.       
  20.                                - Fun-Level - 
  21.                                version 1.10
  22.       
  23.                               by Hugo Fortin
  24.       
  25.       
  26.       
  27.       
  28.       
  29.       
  30.       
  31.       
  32.           Introduction
  33.           ────────────
  34.       
  35.                     Back in early 1990, I used to enter on a board in
  36.                Montreal named Micro-Bytes. That board carried an
  37.                interesting feature: It used to rank its users
  38.                according to their usage of the system. I found the
  39.                idea quite interesting and decided to adapt it on my
  40.                IBM (Micro-Bytes was running on a Mac).
  41.       
  42.                     Using my recently owned Pascal skills, I managed
  43.                to get something and installed it on our board, here,
  44.                in Quebec City. Users quite liked it, so, it stayed
  45.                there. After a while some guy asked me if I could give
  46.                him a copy of the program, so he could install it on
  47.                his own board. I had a problem then, Fun-Level, at that
  48.                time, was written exclusively for PC-BBS (his home
  49.                board) and wouldn't have run on another one. After some
  50.                times, I decided to make it less dependant, more
  51.                polyvalent. So, here it is.
  52.       
  53.                     The program works with QuickBBS systems and those
  54.                with a similar Users.BBS file. It scans the users file,
  55.                calculate a number of points for each user, and then,
  56.                give each of them a rank, according to their total of
  57.                points. Finally, it creates an Ascii (and possibly an
  58.                ANSI file)file that can be displayed in your statistics
  59.                area, or the equivalent.
  60.       
  61.       
  62.  
  63.  
  64.  
  65. Fun-Level v1.10              Monday, March 4, 1991 4:44 pm               Page 2
  66.  
  67.  
  68.       
  69.       
  70.           How is it working?
  71.           ──────────────────
  72.       
  73.                     The method used is quite simple and is based on
  74.                that equation:
  75.       
  76.                Points =   Number of messages left * Pts/Msg
  77.                         + Number of visits on the board * Pts/Vis
  78.                         - (Number of downloads [in K]/Ratio 
  79.                                   - Number of Uploads)
  80.       
  81.                     The Pts/Msg. parameter is the number of points
  82.                allowed for each messages written. In the previous
  83.                version, it was assumed that each messages counted as
  84.                one point. You can now configure it as you wish.
  85.       
  86.                     The Pts/Vis. parameter has the same effect as the
  87.                Pts/Msg. one, but on the number of visits, this time.
  88.       
  89.                     The ratio is how many K the users are allowed to
  90.                Download after having uploaded 1K.
  91.       
  92.                Example:  Ratio is 5, a message  and a visit gives 1
  93.                          point each and the user have the following 
  94.                          stats-> Down.:5000k, Upl.:2500k, Mess.:150, 
  95.                                  Visits:50.
  96.       
  97.                          Point = 150 * 1 + 50 * 1 - (5000/5 - 2500)
  98.                                = 1700 points
  99.       
  100.                     After having calculated the number of points, Fun-
  101.                Level consults his Data File and gives a rank to the
  102.                user.
  103.       
  104.       
  105.           Installation
  106.           ────────────
  107.       
  108.                     Fun-Level is pretty easy to install, you just have
  109.                to 'dump' the content of the archive in your QuickBBS
  110.                directory (or the equivalent). But let's see each steps
  111.                in details:
  112.       
  113.                     If you run Fun-Level alone, without any
  114.                parameters, an help screen will appears to remember you
  115.                the proper use, wich is:
  116.       
  117.                Flevel <Config> [/A]
  118.       
  119.                Where:
  120.       
  121.                     <Config> is the name of the configuration file. An
  122.                example of such file is included in the original
  123.  
  124.  
  125.  
  126. Fun-Level v1.10              Monday, March 4, 1991 4:44 pm               Page 3
  127.  
  128.  
  129.                archive under the name of Flevel.Cfg. You can modify
  130.                any of its lines, according to your specific needs. 
  131.       
  132.                     [/A] is the switch wich tells Fun-Level to create
  133.                an ANSI file in addition to the Ascii file. The three
  134.                colors used by this option can be configured in the
  135.                configuration file, detailed below:
  136.       
  137.       
  138.           * C O N F I G U R A T I O N    F I L E *
  139.       
  140.      Line
  141.      ────
  142.        1       FlevHead.Asc   -> Name of the Ascii heading file
  143.        2       FlevHead.Ans   -> Name of the ANSI  heading file
  144.        3       Flevel.Eng     -> Name of the Data file
  145.        4       Output.Asc     -> Name of the Ascii text file created 
  146.        5       Output.Ans     -> Name of the ANSI  text file created
  147.        6       100            -> Level of the SysOp(s) on the board
  148.        7       SysOp          -> Fun-Level's Rank for the SysOp(s)
  149.        8       10             -> Special level #1
  150.        9       75             -> Bonus #1
  151.       10       20             -> Special level #2
  152.       11       100            -> Bonus #2
  153.       12       5              -> Down/Uploads ratio
  154.       13       1              -> Pt(s) per message
  155.       14       1              -> Pt(s) per visit
  156.       15       9              -> Color of the User's name
  157.       16       10             -> Color of the rank given
  158.       17       15             -> Color for the number of points
  159.       
  160.       
  161.       
  162.           Explanations on Flevel.Cfg
  163.           ──────────────────────────
  164.       
  165.           1 -  The heading file contains the lines that will be
  166.           written before the Fun-Level's ranking. Therefore, you can
  167.           use this facility to introduce the program to your users,
  168.           explain what it is, or anything you wish. An example of such
  169.           file is included (FlevHead.Asc). Please note that there are
  170.           no limitations on the length of this file.
  171.       
  172.       
  173.           2 - Same as the above, except that this file will be
  174.           attributed to the ANSI file created by Fun-Level
  175.           (considering you enabled this function), Therefore, it
  176.           should be an ANSI file (note that an Ascii file will work as
  177.           well, but there wouldn't be any interest in using the ANSI
  178.           feature in that case).
  179.       
  180.       
  181.           3 -  The Data file contains all the possible ranks. The
  182.           format must be identical to the one observed in the two
  183.           examples (Flevel.Eng and Flevel.Fra) included in the
  184.  
  185.  
  186.  
  187. Fun-Level v1.10              Monday, March 4, 1991 4:44 pm               Page 4
  188.  
  189.  
  190.           original archive, wich is, for example:
  191.       
  192.           00006 00015 Student
  193.       
  194.                Wich means that the rank Student will be given for each
  195.           user who have from 6 to 15 points.
  196.       
  197.                You can add as many as you want, just be sure that
  198.           every possibilities are covered, that the numbers don't
  199.           exceed five digits (four and the minus sign for the negative
  200.           ones) and that the ranks don't exceed 35 letters.
  201.       
  202.       
  203.           4 -  The following line shows the name of the final text
  204.           file created by Fun-Level wich will contain the heading and
  205.           the ranking stuff.
  206.       
  207.       
  208.           5 - Same as the above, but for its ANSI counterpart.
  209.       
  210.       
  211.           *    You can add a Path with the five filenames above, if
  212.           necessary. Just be sure to respect the DOS limit, wich is 63
  213.           characters.
  214.       
  215.       
  216.           6 -  This line contains the Level of the SysOp, so he won't
  217.           have to be ranked by Fun-Level.
  218.       
  219.       
  220.           7 -  This line contains the title you wish to have as SysOp.
  221.           This one won't be affected by any of your behaviors on the
  222.           board. SysOps, usually, are good users... -Smile-
  223.       
  224.       
  225.           8 and 10 - Those allow you to specify two levels wich are
  226.           somehow special. Those users will benefit from a substantial
  227.           bonus (if you want) defined in lines 9 and 11. Those bonus
  228.           will be add to their total of points. This feature is useful
  229.           when some of your users have paid a contribution, and
  230.           therefore, are allowed to download more... By entering a
  231.           negative bonus, though, you'll penalize those users. That
  232.           can be useful with annoying visitors... -Grin-
  233.       
  234.       
  235.           9 and 11 - See above.
  236.       
  237.       
  238.           12 - This is the Down/Upload ratio. You enter here how many
  239.           K a user is allowed to Download for each K uploaded.
  240.       
  241.       
  242.           13 - This is the number of points a user will receive for
  243.           each message written.
  244.       
  245.  
  246.  
  247.  
  248. Fun-Level v1.10              Monday, March 4, 1991 4:44 pm               Page 5
  249.  
  250.  
  251.       
  252.           14 - This is the number of points a user will receive for
  253.           each visit on your board.
  254.       
  255.       
  256.           15 - This is the color of the user names in the final ANSI
  257.           file.
  258.       
  259.       
  260.           16 - This is the color of the rank given to each user in the
  261.           final ANSI file.
  262.       
  263.       
  264.           17 - This is the color of the number of points in the final
  265.           ANSI file.
  266.       
  267.           *  The three lines above apply directly in the final ANSI
  268.           file. They could be represented as following:
  269.       
  270.           Hugo Fortin                             SysOp          5000
  271.               ^                                     ^              ^
  272.       line:   15                                    16             17
  273.       
  274.                For the color definition, I used numbers from 1 to 15
  275.           in their usual order, wich is:
  276.       
  277.           1 - Blue            8 - Gray            15 - High-intensity
  278.           2 - Green           9 - Light blue           white
  279.           3 - Cyan           10 - Light green
  280.           4 - Red            11 - Light cyan
  281.           5 - Magenta        12 - Light red  
  282.           6 - Brown          13 - Light magenta
  283.           7 - White          14 - Yellow
  284.       
  285.       
  286.           ** Note that lines 2, 5, 15, 16 and 17 are strictly for ANSI
  287.           operations. However, they HAVE to be present even if you
  288.           don't use this function. In that case, Fun-Level won't
  289.           consider those datas, but they remain essential for the
  290.           smooth running of the program.
  291.       
  292.           Usage
  293.           ─────
  294.       
  295.                     After having completed all the previous steps,
  296.                you're now ready to see some action. Just install Fun-
  297.                Level in your maintenance sequence (usually a Batch
  298.                File executed at night) and allow your users to see the
  299.                results via a Type 39 or a Type 45 menu, within
  300.                QuickBBS, for example.
  301.       
  302.       
  303.           Conclusion
  304.           ──────────
  305.       
  306.  
  307.  
  308.  
  309. Fun-Level v1.10              Monday, March 4, 1991 4:44 pm               Page 6
  310.  
  311.  
  312.                     Fun-Level has been revealing itself to be pretty
  313.                useful either to spot some abusive users, or to know
  314.                about the good ones. It has been somehow a motivation
  315.                for certain users to do well, just to have a better
  316.                rank. Besides it's funny side, the program has a
  317.                certain effect on the behavior of some users and that's
  318.                certainly a positive thing.
  319.       
  320.                     One of the two Data File example is written in
  321.                French, wich is my mother tongue. I had far less
  322.                imagination and inspiration to write its english
  323.                counterpart and therefore, would appreciate a more
  324.                complete version, if someone is willing to send me his
  325.                own.
  326.       
  327.                     Fun-Level was programmed in Turbo-Pascal 5.5, by
  328.                Borland. This version was finished on March 4, 1991, in
  329.                one of those rare free afternoons where College is
  330.                cancelled because of a snow storm.
  331.       
  332.                     I don't ask any money for it, therefore, it's
  333.                FreeWare (not Public Domain, though). However, I'd like
  334.                to hear from you, those who are using it.
  335.       
  336.                     For comments or suggestions, you can reach me via
  337.                FidoNet by NetMail at the following adresses:
  338.                1:240/504, 1:240/507 and 1:240/1
  339.           
  340.                or via regular mail at:
  341.       
  342.                     Hugo Fortin
  343.                     846 du cap
  344.                     St-Nicolas east, PQ
  345.                     Canada
  346.                     G0S 3L0
  347.       
  348.                You can always find the latest version of Fun-Level on:
  349.       
  350.                        PC-BBS, 1:240/504
  351.                        (418)842-6384
  352.                        300/1200/2400 bauds
  353.                        Open every days from 9h PM to 8h AM.
  354.       
  355.       
  356.                     Thanks for having downloaded Fun-Level.
  357.       
  358.       
  359.                     Hugo Fortin -- March 4, 1991.
  360.       
  361.       
  362.       
  363.  
  364.